@opentelemetry/tracing

OpenTelemetry Tracing SDK

The tracing module contains the foundation for all tracing SDKs of opentelemetry-js.

Used standalone, this module provides methods for manual instrumentation of code, offering full control over span creation for client-side JavaScript (browser) and Node.js.

It does not provide automated instrumentation of known libraries, context propagation for asynchronous invocations or distributed-context out-of-the-box.

For automated instrumentation for Node.js, please see @opentelemetry/node.

Installation

npm install --save @opentelemetry/api
npm install --save @opentelemetry/tracing

Usage

const opentelemetry = require('@opentelemetry/api');
const { BasicTracerProvider } = require('@opentelemetry/tracing');

// To start a trace, you first need to initialize the Tracer provider.
// NOTE: The default OpenTelemetry tracer provider does not record any tracing information.
//       Registering a working tracer provider allows the API methods to record traces.
new BasicTracerProvider().register();

// To create a span in a trace, we used the global singleton tracer to start a new span.
const span = opentelemetry.trace.getTracer('default').startSpan('foo');

// Set a span attribute
span.setAttribute('key', 'value');

// We must end the spans so they become available for exporting.
span.end();

Config

Tracing configuration is a merge of user supplied configuration with both the default configuration as specified in config.ts and an environmentally configurable sampling (via OTEL_TRACES_SAMPLER and OTEL_TRACES_SAMPLER_ARG).

Example

See examples/basic-tracer-node for an end-to-end example, including exporting created spans.

Useful links

• For more information on OpenTelemetry, visit: https://opentelemetry.io/
• For more about OpenTelemetry JavaScript: https://github.com/open-telemetry/opentelemetry-js
• For help or feedback on this project, join us in GitHub Discussions

License

Apache 2.0 - See LICENSE for more information.

Changelog

0.19.0

:boom: Breaking Change

• opentelemetry-core, opentelemetry-tracing
  • #2111 feat: handle OTEL_TRACES_SAMPLER env var (@jtmalinowski)
  • #2098 chore(env): update default value for span's attributes/links/events count #1675 (@vmarchaud)
• opentelemetry-instrumentation-fetch, opentelemetry-instrumentation-grpc, opentelemetry-instrumentation-http, opentelemetry-instrumentation-xml-http-request, opentelemetry-semantic-conventions, opentelemetry-tracing, opentelemetry-web
  • #2083 feat: add semconv generator for semantic-conventions-package (@weyert)
• opentelemetry-core, opentelemetry-grpc-utils, opentelemetry-instrumentation-fetch, opentelemetry-instrumentation-grpc, opentelemetry-instrumentation-http, opentelemetry-instrumentation-xml-http-request, opentelemetry-instrumentation, opentelemetry-node, opentelemetry-plugin-grpc-js, opentelemetry-plugin-grpc, opentelemetry-plugin-http, opentelemetry-plugin-https, opentelemetry-sdk-node, opentelemetry-web
  • #2081 remove plugins (@obecny)
• opentelemetry-api-metrics, opentelemetry-context-async-hooks, opentelemetry-context-zone-peer-dep, opentelemetry-core, opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-jaeger, opentelemetry-exporter-prometheus, opentelemetry-exporter-zipkin, opentelemetry-grpc-utils, opentelemetry-instrumentation-fetch, opentelemetry-instrumentation-grpc, opentelemetry-instrumentation-http, opentelemetry-instrumentation-xml-http-request, opentelemetry-instrumentation, opentelemetry-metrics, opentelemetry-node, opentelemetry-plugin-grpc-js, opentelemetry-plugin-grpc, opentelemetry-plugin-http, opentelemetry-plugin-https, opentelemetry-propagator-b3, opentelemetry-propagator-jaeger, opentelemetry-resource-detector-aws, opentelemetry-resource-detector-gcp, opentelemetry-resources, opentelemetry-sdk-node, opentelemetry-shim-opentracing, opentelemetry-tracing, opentelemetry-web
  • #2074 chore: peer depend on API (@dyladan)
  • #2063 chore: update API dependency to 1.0.0-rc.0 (@dyladan)
• opentelemetry-core, opentelemetry-propagator-b3
  • #2054 refactor: simplify b3 options (@mwear)

:rocket: (Enhancement)

• opentelemetry-instrumentation
  • #2135 fix: add isEnabled to InstrumentationBase (@seemk)
• opentelemetry-semantic-conventions
  • #2115 feat: upgrade semantic conventions to v1.2.0 of spec (@weyert)
• opentelemetry-core, opentelemetry-exporter-zipkin
  • #2097 feat(zipkin): allow to configure url via environment #1675 (@vmarchaud)
• opentelemetry-exporter-zipkin
  • #2050 chore: adding interceptor for getting headers before each request (@obecny)
• opentelemetry-exporter-collector-grpc
  • #2092 Migrate exporter-collector-grpc to grpc-js (@obecny)
• opentelemetry-instrumentation-http
  • #2043 chore: avoid unneeded context.with in http instrumentation (@Flarna)
• opentelemetry-instrumentation-fetch, opentelemetry-instrumentation-xml-http-request
  • #2061 chore: adding info to debug whenever headers are being skipped due to cors policy (@obecny)

:bug: (Bug Fix)

• opentelemetry-exporter-prometheus
  • #2121 fix: ensure the label names are sanitised (@weyert)
• opentelemetry-instrumentation
  • #2120 fix(instrumentation): support multiple module definitions with different versions (@seemk)
• opentelemetry-instrumentation-http, opentelemetry-tracing
  • #2105 fix: don't use spanId from invalid parent (@Flarna)
• opentelemetry-context-async-hooks
  • #2088 fix: correct removeAllListeners in case no event is passed (@Flarna)
• opentelemetry-resource-detector-aws
  • #2076 fix: await http response in AWS EKS detector (@vreynolds)
• opentelemetry-core, opentelemetry-propagator-b3, opentelemetry-propagator-jaeger
  • #2082 chore: do not inject span context when instrumentation is suppressed (@dyladan)
• opentelemetry-core
  • #2080 fix: do not inject invalid span context (@dyladan)
• opentelemetry-tracing
  • #2086 fix: exception.type should always be a string (@YanivD)
• opentelemetry-propagator-jaeger
  • #1986 fix(propagator-jaeger): zero pad extracted trace id to 32 characters (@sid-maddy)

:books: (Refine Doc)

• #2094 chore: fixing readme info (@obecny)
• #2051 Add opentelemetry.io docs (@austinlparker)

:house: (Internal)

• opentelemetry-exporter-collector-grpc, opentelemetry-metrics, opentelemetry-tracing
  • #1780 chore: no-floating-promises (@naseemkullah)
• opentelemetry-context-zone, opentelemetry-core, opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-jaeger, opentelemetry-exporter-prometheus, opentelemetry-exporter-zipkin, opentelemetry-instrumentation-fetch, opentelemetry-instrumentation-grpc, opentelemetry-instrumentation-http, opentelemetry-instrumentation-xml-http-request, opentelemetry-instrumentation, opentelemetry-metrics, opentelemetry-node, opentelemetry-propagator-jaeger, opentelemetry-resource-detector-aws, opentelemetry-resource-detector-gcp, opentelemetry-resources, opentelemetry-sdk-node, opentelemetry-shim-opentracing, opentelemetry-tracing, opentelemetry-web
  • #2073 chore: pin own deps (@dyladan)

Committers: 15

• Anuraag Agrawal (@anuraaga)
• Austin Parker (@austinlparker)
• Bartlomiej Obecny (@obecny)
• Daniel Dyla (@dyladan)
• Gerhard Stöbich (@Flarna)
• Jakub Malinowski (@jtmalinowski)
• Matthew Wear (@mwear)
• Naseem (@naseemkullah)
• Niek Kruse (@niekert)
• Siddhesh Mhadnak (@sid-maddy)
• Siim Kallas (@seemk)
• Valentin Marchaud (@vmarchaud)
• Vera Reynolds (@vreynolds)
• Weyert de Boer (@weyert)
• Yaniv Davidi (@YanivD)